home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Canvas / Text.pod < prev    next >
Encoding:
Text File  |  2008-06-14  |  5.8 KB  |  306 lines

  1. =head1 NAME
  2.  
  3. Gnome2::Canvas::Text - Text as CanvasItems
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Glib::InitiallyUnowned
  9.        +----Gtk2::Object
  10.             +----Gnome2::Canvas::Item
  11.                  +----Gnome2::Canvas::Text
  12.  
  13. =for object Gnome2::Canvas::Text - Text as CanvasItems
  14.  
  15. =cut
  16.  
  17.  
  18.  
  19.  
  20. =head1 PROPERTIES
  21.  
  22. =over
  23.  
  24. =item 'anchor' (Gtk2::AnchorType : readable / writable)
  25.  
  26. =item 'attributes' (Gtk2::Pango::AttrList : readable / writable)
  27.  
  28. =item 'clip' (boolean : readable / writable)
  29.  
  30. =item 'clip-height' (double : readable / writable)
  31.  
  32. =item 'clip-width' (double : readable / writable)
  33.  
  34. =item 'family' (string : readable / writable)
  35.  
  36. Name of the font family, e.g. Sans, Helvetica, Times, Monospace
  37.  
  38. =item 'family-set' (boolean : readable / writable)
  39.  
  40. Whether this tag affects the font family
  41.  
  42. =item 'fill-color' (string : readable / writable)
  43.  
  44. Text color, as string
  45.  
  46. =item 'fill-color-gdk' (Gtk2::Gdk::Color : readable / writable)
  47.  
  48. Text color, as a GdkColor
  49.  
  50. =item 'fill-color-rgba' (Glib::UInt : readable / writable)
  51.  
  52. Text color, as an R/G/B/A combined integer
  53.  
  54. =item 'fill-stipple' (Gtk2::Gdk::Drawable : readable / writable)
  55.  
  56. =item 'font' (string : readable / writable)
  57.  
  58. Font description as a string
  59.  
  60. =item 'font-desc' (Gtk2::Pango::FontDescription : readable / writable)
  61.  
  62. Font description as a PangoFontDescription struct
  63.  
  64. =item 'justification' (Gtk2::Justification : readable / writable)
  65.  
  66. =item 'markup' (string : writable)
  67.  
  68. Marked up text to render
  69.  
  70. =item 'rise' (integer : readable / writable)
  71.  
  72. Offset of text above the baseline (below the baseline if rise is negative)
  73.  
  74. =item 'rise-set' (boolean : readable / writable)
  75.  
  76. Whether this tag affects the rise
  77.  
  78. =item 'scale' (double : readable / writable)
  79.  
  80. Size of font, relative to default size
  81.  
  82. =item 'scale-set' (boolean : readable / writable)
  83.  
  84. Whether this tag affects font scaling
  85.  
  86. =item 'size' (integer : readable / writable)
  87.  
  88. Font size (as a multiple of PANGO_SCALE, eg. 12*PANGO_SCALE for a 12pt font size)
  89.  
  90. =item 'size-points' (double : readable / writable)
  91.  
  92. Font size in points (eg. 12 for a 12pt font size)
  93.  
  94. =item 'size-set' (boolean : readable / writable)
  95.  
  96. Whether this tag affects the font size
  97.  
  98. =item 'stretch' (Gtk2::Pango::Stretch : readable / writable)
  99.  
  100. Font stretch
  101.  
  102. =item 'stretch-set' (boolean : readable / writable)
  103.  
  104. Whether this tag affects the font stretch
  105.  
  106. =item 'strikethrough' (boolean : readable / writable)
  107.  
  108. Whether to strike through the text
  109.  
  110. =item 'strikethrough-set' (boolean : readable / writable)
  111.  
  112. Whether this tag affects strikethrough
  113.  
  114. =item 'style' (Gtk2::Pango::Style : readable / writable)
  115.  
  116. Font style
  117.  
  118. =item 'style-set' (boolean : readable / writable)
  119.  
  120. Whether this tag affects the font style
  121.  
  122. =item 'text' (string : readable / writable)
  123.  
  124. Text to render
  125.  
  126. =item 'text-height' (double : readable)
  127.  
  128. Height of the rendered text
  129.  
  130. =item 'text-width' (double : readable)
  131.  
  132. Width of the rendered text
  133.  
  134. =item 'underline' (Gtk2::Pango::Underline : readable / writable)
  135.  
  136. Style of underline for this text
  137.  
  138. =item 'underline-set' (boolean : readable / writable)
  139.  
  140. Whether this tag affects underlining
  141.  
  142. =item 'variant' (Gtk2::Pango::Variant : readable / writable)
  143.  
  144. Font variant
  145.  
  146. =item 'variant-set' (boolean : readable / writable)
  147.  
  148. Whether this tag affects the font variant
  149.  
  150. =item 'weight' (integer : readable / writable)
  151.  
  152. Font weight
  153.  
  154. =item 'weight-set' (boolean : readable / writable)
  155.  
  156. Whether this tag affects the font weight
  157.  
  158. =item 'x' (double : readable / writable)
  159.  
  160. =item 'x-offset' (double : readable / writable)
  161.  
  162. =item 'y' (double : readable / writable)
  163.  
  164. =item 'y-offset' (double : readable / writable)
  165.  
  166. =back
  167.  
  168.  
  169. =head1 ENUMS AND FLAGS
  170.  
  171. =head2 enum Gtk2::AnchorType
  172.  
  173. =over
  174.  
  175. =item * 'center' / 'GTK_ANCHOR_CENTER'
  176.  
  177. =item * 'north' / 'GTK_ANCHOR_NORTH'
  178.  
  179. =item * 'north-west' / 'GTK_ANCHOR_NORTH_WEST'
  180.  
  181. =item * 'north-east' / 'GTK_ANCHOR_NORTH_EAST'
  182.  
  183. =item * 'south' / 'GTK_ANCHOR_SOUTH'
  184.  
  185. =item * 'south-west' / 'GTK_ANCHOR_SOUTH_WEST'
  186.  
  187. =item * 'south-east' / 'GTK_ANCHOR_SOUTH_EAST'
  188.  
  189. =item * 'west' / 'GTK_ANCHOR_WEST'
  190.  
  191. =item * 'east' / 'GTK_ANCHOR_EAST'
  192.  
  193. =item * 'n' / 'GTK_ANCHOR_N'
  194.  
  195. =item * 'nw' / 'GTK_ANCHOR_NW'
  196.  
  197. =item * 'ne' / 'GTK_ANCHOR_NE'
  198.  
  199. =item * 's' / 'GTK_ANCHOR_S'
  200.  
  201. =item * 'sw' / 'GTK_ANCHOR_SW'
  202.  
  203. =item * 'se' / 'GTK_ANCHOR_SE'
  204.  
  205. =item * 'w' / 'GTK_ANCHOR_W'
  206.  
  207. =item * 'e' / 'GTK_ANCHOR_E'
  208.  
  209. =back
  210.  
  211.  
  212. =head2 enum Gtk2::Justification
  213.  
  214. =over
  215.  
  216. =item * 'left' / 'GTK_JUSTIFY_LEFT'
  217.  
  218. =item * 'right' / 'GTK_JUSTIFY_RIGHT'
  219.  
  220. =item * 'center' / 'GTK_JUSTIFY_CENTER'
  221.  
  222. =item * 'fill' / 'GTK_JUSTIFY_FILL'
  223.  
  224. =back
  225.  
  226.  
  227. =head2 enum Gtk2::Pango::Stretch
  228.  
  229. =over
  230.  
  231. =item * 'ultra-condensed' / 'PANGO_STRETCH_ULTRA_CONDENSED'
  232.  
  233. =item * 'extra-condensed' / 'PANGO_STRETCH_EXTRA_CONDENSED'
  234.  
  235. =item * 'condensed' / 'PANGO_STRETCH_CONDENSED'
  236.  
  237. =item * 'semi-condensed' / 'PANGO_STRETCH_SEMI_CONDENSED'
  238.  
  239. =item * 'normal' / 'PANGO_STRETCH_NORMAL'
  240.  
  241. =item * 'semi-expanded' / 'PANGO_STRETCH_SEMI_EXPANDED'
  242.  
  243. =item * 'expanded' / 'PANGO_STRETCH_EXPANDED'
  244.  
  245. =item * 'extra-expanded' / 'PANGO_STRETCH_EXTRA_EXPANDED'
  246.  
  247. =item * 'ultra-expanded' / 'PANGO_STRETCH_ULTRA_EXPANDED'
  248.  
  249. =back
  250.  
  251.  
  252. =head2 enum Gtk2::Pango::Style
  253.  
  254. =over
  255.  
  256. =item * 'normal' / 'PANGO_STYLE_NORMAL'
  257.  
  258. =item * 'oblique' / 'PANGO_STYLE_OBLIQUE'
  259.  
  260. =item * 'italic' / 'PANGO_STYLE_ITALIC'
  261.  
  262. =back
  263.  
  264.  
  265. =head2 enum Gtk2::Pango::Underline
  266.  
  267. =over
  268.  
  269. =item * 'none' / 'PANGO_UNDERLINE_NONE'
  270.  
  271. =item * 'single' / 'PANGO_UNDERLINE_SINGLE'
  272.  
  273. =item * 'double' / 'PANGO_UNDERLINE_DOUBLE'
  274.  
  275. =item * 'low' / 'PANGO_UNDERLINE_LOW'
  276.  
  277. =item * 'error' / 'PANGO_UNDERLINE_ERROR'
  278.  
  279. =back
  280.  
  281.  
  282. =head2 enum Gtk2::Pango::Variant
  283.  
  284. =over
  285.  
  286. =item * 'normal' / 'PANGO_VARIANT_NORMAL'
  287.  
  288. =item * 'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
  289.  
  290. =back
  291.  
  292.  
  293.  
  294. =head1 SEE ALSO
  295.  
  296. L<Gnome2::Canvas>, L<Glib::Object>, L<Glib::InitiallyUnowned>, L<Gtk2::Object>, L<Gnome2::Canvas::Item>
  297.  
  298. =head1 COPYRIGHT
  299.  
  300. Copyright (C) 2003-2004 by the Gtk2-Perl Team.
  301.  
  302. This software is licensed under the LGPL; see L<Gnome2::Canvas> for a full notice.
  303.  
  304. =cut
  305.  
  306.